TMS Infrastructure
Domain Message Specification

Version: 5.7; Status: Final

Withdrawal Tabular View

UKCI_RM000001UK02
MessageWithdrawal

A message to request the withdrawal of a message sent previously. The previously sent message should contain a factual error requiring correction.
Used by:
[1..1] classCode (CS { CNE:ACTN} ){ } Fixed="ACTN"

A code indicating that the receiving system is requested to take action based on the payload of this message.

  • Fixed value: "ACTN"
[1..1] moodCode (CS { CNE:RQO} ){ } Fixed="RQO"

Indicates that this is a request or order for a service.

  • Fixed value: "RQO"
[1..1] id (II)

A unique identifier for this instance of the focal act of message withdrawal.

The Identifier Global datatype flavour is used to carry this information as follows:

  • The root attribute shall contain a DCE UUID.
[1..1] code (CV { CNE:MessageControl} ){ } Fixed="01"

A code indicating that the message is a notification that a message should be withdrawn.

  • The code System attribute shall contain the OID for
    WithdrawalReason"2.16.840.1.113883.2.1.3.2.4.17.144".
  • The code attribute shall be fixed at "01".
  • The display text shall carry a description of the code representing the meaning of the code fixed at "Withdraw Message"
[1..1] effectiveTime (TS)

The time of creation of this withdrawal message.
[1..1] recordTarget

Refers to the patient who was the record target of the message being withdrawn.
[1..1] typeCode (CS { CNE:RCT} ){ } Fixed="RCT"

Indicates the role of patient as record target.

  • Fixed value: "RCT"
[1..1] patient (Patient)

The person who is the patient. If a withdrawal message is being sent then this must be included.
[1..1] author

Links to the author of the request to withdraw the message.
[1..1] typeCode (CS { CNE:AUT} ){ } Fixed="AUT"

Indicates that the role is the author

  • Fixed value: "AUT"
[1..1] contextControlCode (CS { CNE:OP} ){ } Fixed="OP"

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Fixed value: "OP" - Overriding and propagating

The value of "OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.
[1..1] agent [CMET: UKCT_MT120301UK02]

NPfIT CMET to identify a person who is the primary performer of this action.

Full details of the person and role profile are available from SDS.

Only the following Classes and Attributes from this CMET shall be included in this message. Classes and attributes that are not detailed below are not to be used in this message.

AgentPersonSDS.id shall carry An SDS identifier that uniquely identifies the Role of the Person in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.67
  • The extension attribute shall contain the SDS Role Profile ID

PersonSDS.id shall carry an SDS identifier that uniquely identifies the Person in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.65
  • The extension attribute shall contain the SDS User ID
[1..1] reason

Link to the reason for message withdrawal.
[1..1] typeCode (CS { CNE:RSON} ){ } Fixed="RSON"

Indicates a 'reason' relationship.

  • Fixed value: "RSON"
[1..1] contextConductionInd (BL){ } Fixed="true"

Associations in the parent act are conducted across the ActRelationship to the child act.

  • Fixed value: "true"
[1..1] justifyingReason (Reason)

The reason claimed for message withdrawal.
[1..1] subject

Link to the subject of the withdrawal message.
[1..1] typeCode (CS { CNE:SUBJ} ){ } Fixed="SUBJ"

Indicates that the domain payload entry point act is the subject of the Control Act.

  • Fixed value: "SUBJ"
[1..1] messageRef (MessageRef)

A reference to the message requested to be withdrawn.
Patient

Refers to the patient who was the record target of the message being withdrawn.
Used by: MessageWithdrawal
[1..1] classCode (CS { CNE:PAT} ){ } Fixed="PAT"

Indicates that the role is that of a patient.

  • Fixed value: "PAT"
[1..1] id (II)

To provide the nationally recognised identifier for the patient, the NHS number.

The Identifier External datatype flavour is used to carry this information as follows:-

An NHS number is carried in the following way:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1"
  • The extension attribute will contain the NHS number.
Reason

The reason that a withdrawal has been requested for this message.
Used by: MessageWithdrawal
[1..1] classCode (CS { CNE:OBS} ){ } Fixed="OBS"

Indicates that this is an observation.

  • Fixed value: "OBS"
[1..1] moodCode (CS { CNE:EVN} ){ } Fixed="EVN"

Indicates that this refers to an event.

  • Fixed value: "EVN"
[1..1] code (CV { CNE:WithdrawalReason} )

A code indicating the reason for message withdrawal.

  • The code System attribute shall contain the OID for
    WithdrawalReason"2.16.840.1.113883.2.1.3.2.4.17.143".
  • The code attribute shall contain a value from the vocabulary.
  • The display text shall carry a description of the code representing the meaning of the code.
[0..1] text (ST)

Optional text providing supplementary information pertinent to the withdrawal reason.
MessageRef

Reference to the message to be withdrawn.
Used by: MessageWithdrawal
[1..1] classCode (CS { CNE:ActClass} )

Should indicate the classCode of the focal act of the target message for withdrawal.
[1..1] moodCode (CS { CNE:ActMood} )

Should indicate the mood of the focal act of the target message for withdrawal.
[1..1] id (II)

The unique identifier of the focal act that is being referenced. This is the .id attribute of the focal act of the message being referenced.

The Identifier Global datatype flavour is used to carry this information as follows:

  • A UUID is held in the root attribute